Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Website: Update CRD API docs only if sorted files different #1694

Merged
merged 1 commit into from
Jul 16, 2020
Merged

Website: Update CRD API docs only if sorted files different #1694

merged 1 commit into from
Jul 16, 2020

Conversation

aLekSer
Copy link
Collaborator

@aLekSer aLekSer commented Jul 15, 2020 •
edited
Loading

make test-gen-api-docs gives lots of false positive failures.

What type of PR is this?

/kind bug

What this PR does / Why we need it:

The tool we are using could not preserve the ordering for APIGroups that's why file could be presented in a number of different ways.

Ordering of APIGroups do not change the logic of the resulted file contents especially for the case when they are on the same level in the docs.
Commutative property of the set (of APIGroups).

Which issue(s) this PR fixes:
Closes #1690

Special notes for your reviewer:
Thank you.

@aLekSer
Update CRD api docs only if sorted files different
60fbb17 
Ordering of APIGroups do not change the logic of the resulted file contents
especially for the case when they are on the same level in the docs.
Commutative property of the enumeration.
@aLekSer aLekSer changed the title Update CRD api docs only if sorted files different Website: Update CRD API docs only if sorted files different Jul 15, 2020
@aLekSer aLekSer added the area/site The website itself - including redirects, styling, search, etc label Jul 15, 2020
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: dc4a5708-6601-4110-8f51-e99f2d6f3dc6

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/1694/head:pr_1694 && git checkout pr_1694
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.8.0-60fbb17

markmandel
markmandel approved these changes Jul 16, 2020
View reviewed changes
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aLekSer, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@markmandel markmandel merged commit f3ae873 into googleforgames:master Jul 16, 2020
@markmandel markmandel added this to the 1.8.0 milestone Jul 16, 2020
@ahmetb
Copy link

ahmetb commented Jul 16, 2020

It's a good hack. 👍🏼 sorry about not being able to fix this in the upstream timely. If you have some cycles to take a look at the upstream, it should be an easy thing to fix. It seems both "package list" and "type list" is not sorted deterministically right now.

@aLekSer aLekSer deleted the fix/gen-api-docs-order branch July 17, 2020 08:47
ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020
@aLekSer @ilkercelikyilmaz
Update CRD api docs only if sorted files different (googleforgames#1694)
fe28258 
Ordering of APIGroups do not change the logic of the resulted file contents
especially for the case when they are on the same level in the docs.
Commutative property of the enumeration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmandel markmandel markmandel approved these changes

@pooneh-m pooneh-m Awaiting requested review from pooneh-m

@roberthbailey roberthbailey Awaiting requested review from roberthbailey

Assignees

@markmandel markmandel

Labels
approved area/site The website itself - including redirects, styling, search, etc cla: yes lgtm size/XS
Projects
None yet
Milestone
1.8.0
Development

Successfully merging this pull request may close these issues.

CI: make test-gen-api-docs is failing quite often
6 participants
@aLekSer @agones-bot @google-oss-robot @ahmetb @markmandel @googlebot